Document cbrain specific boutiques properties (extensions) #1128#1378
Document cbrain specific boutiques properties (extensions) #1128#1378MontrealSergiy wants to merge 2 commits intoaces:masterfrom
Conversation
prioux
left a comment
There was a problem hiding this comment.
This doc is good but it has indentations problems (e.g. line 228) and overall it should match the conventions for RDOC blocks. Try to put your new large comment block at the beginning of a method and generate the rdoc with the rake tasks, and inspect the results with yoru browser. Make sure it looks good!
I would prefer all your new methods that end with "custom" in their names ot START with "custom" instead. E.g. instead of allow_empty_strings_custom, use custom_allow_empty_strings.
|
I'll add a few directives to facilitate automated generation of documentation by rdoc, and, following @natacha-beck suggestion, move the property table into a separate file |
b92ab38 to
fa39351
Compare
|
Tested with rdoc 6.6.2, please check now @prioux @natacha-beck |
|
So I understand that adding comments in the BoutiquesSupport module was made difficult because many classes, instead of being declared like the standard: class BoutiquesDescriptor < RestrictedHash
endwere instead declared with meta programming, as in: BoutiquesDescriptor = Class.new(RestrictedHash) do
endSo the RDOC parser couldn't really identify what methods were in which class. Well, I solved that problem by modifying boutiques_support.rb and re-coding all the declarations The commit for my change are in master and can be seen in Please rebase to master, take the documentation in this PR and just move it to their proper methods, in |
f7f9c9e to
549a882
Compare
see #1128